Directories

Macros
#define	SYDirectory   DIR*
#define	syInvalidateDirectory(_pd)   *(_pd) = NULL
#define	syIsValidDirectory(_d)   (_d != NULL)

Functions
NQ_STATUS	syCreateDirectory (const NQ_WCHAR *name)
NQ_STATUS	syDeleteDirectory (const NQ_WCHAR *name)
SYDirectory	syOpenDirectory (const NQ_WCHAR *name)
NQ_STATUS	syFirstDirectoryFile (const NQ_WCHAR *name, SYDirectory *pDir, const NQ_WCHAR **fileName)
NQ_STATUS	syNextDirectoryFile (SYDirectory dir, const NQ_WCHAR **fileName)
NQ_STATUS	syCloseDirectory (SYDirectory dir)

Detailed Description

Macro Definition Documentation

#define SYDirectory   DIR*

#define syInvalidateDirectory

(

_pd

)

*(_pd) = NULL

#define syIsValidDirectory

(

_d

)

(_d != NULL)

Function Documentation

NQ_STATUS syCreateDirectory

(

const NQ_WCHAR *

name

)

Create directory

Parameters

name	Full directory path

Returns

NQ_SUCCESS or NQ_FAIL

NQ_STATUS syDeleteDirectory

(

const NQ_WCHAR *

name

)

Delete directory

Parameters

name	Full directory path

Returns

NQ_SUCCESS or NQ_FAIL

SYDirectory syOpenDirectory

(

const NQ_WCHAR *

name

)

Open directory by name

Parameters

name	Full directory path

Returns

Directory handle or invalid handle

NQ_STATUS syFirstDirectoryFile	(	const NQ_WCHAR *	name,
		SYDirectory *	pDir,
		const NQ_WCHAR **	fileName
	)

Open directory and read the first entry

Parameters

name	Full directory path
pDir	Buffer for directory handle
fileName	Buffer for a pointer to the file name

Returns

NQ_SUCCESS or NQ_FAIL

NQ_STATUS syNextDirectoryFile	(	SYDirectory	dir,
		const NQ_WCHAR **	fileName
	)

Read next directory entry

Parameters

dir	Directory handle
fileName	Buffer for a pointer to the file name

Returns

NQ_SUCCESS or NQ_FAIL

NQ_STATUS syCloseDirectory

(

SYDirectory

dir

)

Close directory handle

Parameters

dir	Directory handle

Returns

NQ_SUCCESS if the operation succeeded, NQ_FAIL if an error occurred.